Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate Dice from classification and re-add to segmentation #2725

Open
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

SkafteNicki
Copy link
Member

@SkafteNicki SkafteNicki commented Sep 8, 2024

What does this PR do?

Going to deprecate the current implementation of dice from the classification domain. It is completely outdated because it was not updated back in v0.11 as all the other classification metrics, mainly due to it in principal being equal to f1 score if we look at the math.
As it is being deprecated a new version is going to be added to the segmentation domain such that we both have dice and generalized dice for that domain. At the same time I make sure the new implementation will fix all issues related to the old implementation:

Fixes #2323
Fixes #2262
Fixes #1602
Fixes #1425

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃


📚 Documentation preview 📚: https://torchmetrics--2725.org.readthedocs.build/en/2725/

@SkafteNicki SkafteNicki added bug / fix Something isn't working enhancement New feature or request New metric labels Sep 8, 2024
@SkafteNicki SkafteNicki added this to the v1.5.0 milestone Sep 8, 2024
@SkafteNicki SkafteNicki self-assigned this Sep 8, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation topic: Classif labels Sep 8, 2024
Copy link

codecov bot commented Sep 8, 2024

Codecov Report

Attention: Patch coverage is 87.75510% with 12 lines in your changes missing coverage. Please review.

Project coverage is 69%. Comparing base (4c75369) to head (6d5ab70).

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #2725   +/-   ##
======================================
  Coverage      69%     69%           
======================================
  Files         338     340    +2     
  Lines       18334   18430   +96     
======================================
+ Hits        12586   12670   +84     
- Misses       5748    5760   +12     

@SkafteNicki SkafteNicki removed this from the v1.5.0 milestone Oct 21, 2024
@SkafteNicki SkafteNicki added this to the v1.6.0 milestone Oct 21, 2024
@SkafteNicki SkafteNicki marked this pull request as ready for review October 24, 2024 10:05
@mergify mergify bot added the ready label Oct 24, 2024
@Borda Borda requested a review from baskrahmer October 25, 2024 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug / fix Something isn't working documentation Improvements or additions to documentation enhancement New feature or request New metric ready topic: Classif
Projects
None yet
2 participants